﻿#region License

// Copyright (c) 2009, Bill O'Neill (william.w.oneill@gmail.com)
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without 
// modification, are permitted provided that the following conditions 
// are met:
// 
// 1. Redistributions of source code must retain the above copyright 
// notice, this list of conditions and the following disclaimer.
// 
// 2. Redistributions in binary form must reproduce the above copyright 
// notice, this list of conditions and the following disclaimer in the 
// documentation and/or other materials provided with the distribution.
// 
// 3. Neither the name of Focal Point Technology Solutions, LLC nor 
// the names of its contributors may be used to endorse or promote 
// products derived from this software without specific prior written 
// permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
// CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
// DAMAGE.

#endregion

using System.Collections.Generic;
using System.IO.Ports;
using System;

namespace X10d.Interface
{
	/// <summary>
	/// Command complete event arguments
	/// </summary>
	public class CommandCompleteEventArgs : EventArgs
	{
		public DeviceCommand Command { get; set; }
	}

	/// <summary>
	/// Interface for classes that interact with the X10 interfaces by submitting and receiving requests.
	/// </summary>
	internal interface IRequestManager
	{
		/// <summary>
		/// Transitions the state machine to the next state
		/// </summary>
		/// <param name="nextState">
		/// A reference to the next state.
		/// </param>
		void TransitionToState(IPortState nextState);

		/// <summary>
		/// Gets a reference to the current state object
		/// </summary>
		IPortState CurrentState { get; }

		/// <summary>
		/// Gets a reference to the managed port
		/// </summary>
		SerialPort Port { get; }

		/// <summary>
		/// Gets the current command. 
		/// </summary>
		/// <remarks>
		/// Will be <c>null</c> when no command is active.
		/// </remarks>
		DeviceCommand CurrentCommand { get; }

		/// <summary>
		/// Event raised when a command completes
		/// </summary>
		event EventHandler<CommandCompleteEventArgs> CommandComplete;
	}
}